<!DOCTYPE html>
<html lang="en-US">
<head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="language" content="en" />
        <link href="./assets/ffd55088/css/bootstrap.css" rel="stylesheet">
<link href="./assets/5cf9384a/solarized_light.css" rel="stylesheet">
<link href="./assets/6c54116e/style.css" rel="stylesheet">
<script src="./assets/a44cef0f/jquery.js"></script>
<script src="./assets/ffd55088/js/bootstrap.js"></script>
<script src="./assets/8ac4e28a/jssearch.js"></script>    <title>ApiRenderer, yii\apidoc\templates\html\ApiRenderer - Yii Framework 2.0 API Documentation</title>
</head>
<body>

<div class="wrap">
    <nav id="w10781" class="navbar-inverse navbar-fixed-top navbar" role="navigation"><div class="navbar-header"><button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#w10781-collapse"><span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span></button><a class="navbar-brand" href="./index.html">Yii Framework 2.0 API Documentation</a></div><div id="w10781-collapse" class="collapse navbar-collapse"><ul id="w10782" class="navbar-nav nav"><li><a href="./index.html">Class reference</a></li>
<li class="dropdown"><a class="dropdown-toggle" href="#" data-toggle="dropdown">Extensions <b class="caret"></b></a><ul id="w10783" class="dropdown-menu"><li><a href="./ext-apidoc-index.html" tabindex="-1">apidoc</a></li>
<li><a href="./ext-authclient-index.html" tabindex="-1">authclient</a></li>
<li><a href="./ext-bootstrap-index.html" tabindex="-1">bootstrap</a></li>
<li><a href="./ext-codeception-index.html" tabindex="-1">codeception</a></li>
<li><a href="./ext-debug-index.html" tabindex="-1">debug</a></li>
<li><a href="./ext-elasticsearch-index.html" tabindex="-1">elasticsearch</a></li>
<li><a href="./ext-faker-index.html" tabindex="-1">faker</a></li>
<li><a href="./ext-gii-index.html" tabindex="-1">gii</a></li>
<li><a href="./ext-imagine-index.html" tabindex="-1">imagine</a></li>
<li><a href="./ext-jui-index.html" tabindex="-1">jui</a></li>
<li><a href="./ext-mongodb-index.html" tabindex="-1">mongodb</a></li>
<li><a href="./ext-redis-index.html" tabindex="-1">redis</a></li>
<li><a href="./ext-smarty-index.html" tabindex="-1">smarty</a></li>
<li><a href="./ext-sphinx-index.html" tabindex="-1">sphinx</a></li>
<li><a href="./ext-swiftmailer-index.html" tabindex="-1">swiftmailer</a></li>
<li><a href="./ext-twig-index.html" tabindex="-1">twig</a></li></ul></li>
<li><a href="./guide-README.html">Guide</a></li></ul><div class="navbar-form navbar-left" role="search">
  <div class="form-group">
    <input id="searchbox" type="text" class="form-control" placeholder="Search">
  </div>
</div>
</div></nav>
    <div id="search-resultbox" style="display: none;" class="modal-content">
        <ul id="search-results">
        </ul>
    </div>

    
<div class="row">
    <div class="col-md-3">
                <div id="navigation" class="list-group"><a class="list-group-item" href="#navigation-10770" data-toggle="collapse" data-parent="#navigation">yii\apidoc\commands <b class="caret"></b></a><div id="navigation-10770" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-apidoc-commands-apicontroller.html">ApiController</a>
<a class="list-group-item" href="./yii-apidoc-commands-guidecontroller.html">GuideController</a></div>
<a class="list-group-item" href="#navigation-10771" data-toggle="collapse" data-parent="#navigation">yii\apidoc\components <b class="caret"></b></a><div id="navigation-10771" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-apidoc-components-basecontroller.html">BaseController</a></div>
<a class="list-group-item" href="#navigation-10772" data-toggle="collapse" data-parent="#navigation">yii\apidoc\helpers <b class="caret"></b></a><div id="navigation-10772" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-apidoc-helpers-apiindexer.html">ApiIndexer</a>
<a class="list-group-item" href="./yii-apidoc-helpers-apimarkdown.html">ApiMarkdown</a>
<a class="list-group-item" href="./yii-apidoc-helpers-apimarkdownlatex.html">ApiMarkdownLaTeX</a>
<a class="list-group-item" href="./yii-apidoc-helpers-apimarkdowntrait.html">ApiMarkdownTrait</a>
<a class="list-group-item" href="./yii-apidoc-helpers-indexfileanalyzer.html">IndexFileAnalyzer</a>
<a class="list-group-item" href="./yii-apidoc-helpers-prettyprinter.html">PrettyPrinter</a></div>
<a class="list-group-item" href="#navigation-10773" data-toggle="collapse" data-parent="#navigation">yii\apidoc\models <b class="caret"></b></a><div id="navigation-10773" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-apidoc-models-basedoc.html">BaseDoc</a>
<a class="list-group-item" href="./yii-apidoc-models-classdoc.html">ClassDoc</a>
<a class="list-group-item" href="./yii-apidoc-models-constdoc.html">ConstDoc</a>
<a class="list-group-item" href="./yii-apidoc-models-context.html">Context</a>
<a class="list-group-item" href="./yii-apidoc-models-eventdoc.html">EventDoc</a>
<a class="list-group-item" href="./yii-apidoc-models-functiondoc.html">FunctionDoc</a>
<a class="list-group-item" href="./yii-apidoc-models-interfacedoc.html">InterfaceDoc</a>
<a class="list-group-item" href="./yii-apidoc-models-methoddoc.html">MethodDoc</a>
<a class="list-group-item" href="./yii-apidoc-models-paramdoc.html">ParamDoc</a>
<a class="list-group-item" href="./yii-apidoc-models-propertydoc.html">PropertyDoc</a>
<a class="list-group-item" href="./yii-apidoc-models-traitdoc.html">TraitDoc</a>
<a class="list-group-item" href="./yii-apidoc-models-typedoc.html">TypeDoc</a></div>
<a class="list-group-item" href="#navigation-10774" data-toggle="collapse" data-parent="#navigation">yii\apidoc\renderers <b class="caret"></b></a><div id="navigation-10774" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-apidoc-renderers-apirenderer.html">ApiRenderer</a>
<a class="list-group-item" href="./yii-apidoc-renderers-baserenderer.html">BaseRenderer</a>
<a class="list-group-item" href="./yii-apidoc-renderers-guiderenderer.html">GuideRenderer</a></div>
<a class="list-group-item" href="#navigation-10775" data-toggle="collapse" data-parent="#navigation">yii\apidoc\templates\bootstrap <b class="caret"></b></a><div id="navigation-10775" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-apidoc-templates-bootstrap-apirenderer.html">ApiRenderer</a>
<a class="list-group-item" href="./yii-apidoc-templates-bootstrap-guiderenderer.html">GuideRenderer</a>
<a class="list-group-item" href="./yii-apidoc-templates-bootstrap-renderertrait.html">RendererTrait</a>
<a class="list-group-item" href="./yii-apidoc-templates-bootstrap-sidenavwidget.html">SideNavWidget</a></div>
<a class="list-group-item" href="#navigation-10776" data-toggle="collapse" data-parent="#navigation">yii\apidoc\templates\bootstrap\assets <b class="caret"></b></a><div id="navigation-10776" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-apidoc-templates-bootstrap-assets-assetbundle.html">AssetBundle</a>
<a class="list-group-item" href="./yii-apidoc-templates-bootstrap-assets-highlightbundle.html">HighlightBundle</a>
<a class="list-group-item" href="./yii-apidoc-templates-bootstrap-assets-jssearchasset.html">JsSearchAsset</a></div>
<a class="list-group-item active" href="#navigation-10777" data-toggle="collapse" data-parent="#navigation">yii\apidoc\templates\html <b class="caret"></b></a><div id="navigation-10777" class="submenu panel-collapse collapse in"><a class="list-group-item active" href="./yii-apidoc-templates-html-apirenderer.html">ApiRenderer</a>
<a class="list-group-item" href="./yii-apidoc-templates-html-guiderenderer.html">GuideRenderer</a></div>
<a class="list-group-item" href="#navigation-10778" data-toggle="collapse" data-parent="#navigation">yii\apidoc\templates\json <b class="caret"></b></a><div id="navigation-10778" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-apidoc-templates-json-apirenderer.html">ApiRenderer</a></div>
<a class="list-group-item" href="#navigation-10779" data-toggle="collapse" data-parent="#navigation">yii\apidoc\templates\online <b class="caret"></b></a><div id="navigation-10779" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-apidoc-templates-online-apirenderer.html">ApiRenderer</a></div>
<a class="list-group-item" href="#navigation-10780" data-toggle="collapse" data-parent="#navigation">yii\apidoc\templates\pdf <b class="caret"></b></a><div id="navigation-10780" class="submenu panel-collapse collapse"><a class="list-group-item" href="./yii-apidoc-templates-pdf-guiderenderer.html">GuideRenderer</a></div></div>    </div>
    <div class="col-md-9 api-content" role="main">
        <h1>Class yii\apidoc\templates\html\ApiRenderer</h1>
<div class="top-nav">
    <a href="index.html">All Classes</a>
            | <a href="#properties">Properties</a>
                | <a href="#methods">Methods</a>
                    | <a href="#constants">Constants</a>
    </div>

<table class="summaryTable docClass table table-bordered">
    <colgroup>
        <col class="col-name" />
        <col class="col-value" />
    </colgroup>
            <tr><th>Inheritance</th><td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a> &raquo;
<a href="yii-apidoc-renderers-apirenderer.html">yii\apidoc\renderers\ApiRenderer</a> &raquo;
<a href="yii-apidoc-renderers-baserenderer.html">yii\apidoc\renderers\BaseRenderer</a> &raquo;
<a href="yii-base-component.html">yii\base\Component</a> &raquo;
<a href="yii-base-object.html">yii\base\Object</a></td></tr>
                <tr><th>Implements</th><td><a href="yii-base-configurable.html">yii\base\Configurable</a>, <a href="yii-base-viewcontextinterface.html">yii\base\ViewContextInterface</a></td></tr>
                        <tr><th>Subclasses</th><td><a href="yii-apidoc-templates-bootstrap-apirenderer.html">yii\apidoc\templates\bootstrap\ApiRenderer</a>, <a href="yii-apidoc-templates-online-apirenderer.html">yii\apidoc\templates\online\ApiRenderer</a></td></tr>
                        <tr><th>Available since version</th><td>2.0</td></tr>
                    <tr>
          <th>Source Code</th>
          <td><a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php">https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php</a></td>
        </tr>
    </table>

<div class="class-description">
    <p><strong>The base class for HTML API documentation renderers.</strong></p>
    
    </div>

<a id="properties"></a>

<div class="summary doc-property">
<h2>Public Properties</h2>

<p><a href="#" class="toggle">Hide inherited properties</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-property" />
    <col class="col-type" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Property</th><th>Type</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="$apiContext">
        <td><a href="yii-apidoc-renderers-baserenderer.html#$apiContext-detail">$apiContext</a></td>
        <td><a href="yii-apidoc-models-context.html">yii\apidoc\models\Context</a></td>
        <td>The <a href="yii-apidoc-models-context.html">yii\apidoc\models\Context</a> currently being rendered.</td>
        <td><a href="yii-apidoc-renderers-baserenderer.html">yii\apidoc\renderers\BaseRenderer</a></td>
    </tr>
            <tr class="inherited" id="$apiUrl">
        <td><a href="yii-apidoc-renderers-baserenderer.html#$apiUrl-detail">$apiUrl</a></td>
        <td></td>
        <td></td>
        <td><a href="yii-apidoc-renderers-baserenderer.html">yii\apidoc\renderers\BaseRenderer</a></td>
    </tr>
            <tr class="inherited" id="$behaviors">
        <td><a href="yii-base-component.html#$behaviors-detail">$behaviors</a></td>
        <td><a href="yii-base-behavior.html">yii\base\Behavior</a>[]</td>
        <td>List of behaviors attached to this component</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="$controller">
        <td><a href="yii-apidoc-renderers-baserenderer.html#$controller-detail">$controller</a></td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
        <td>The apidoc controller instance.</td>
        <td><a href="yii-apidoc-renderers-baserenderer.html">yii\apidoc\renderers\BaseRenderer</a></td>
    </tr>
            <tr class="inherited" id="$guidePrefix">
        <td><a href="yii-apidoc-renderers-baserenderer.html#$guidePrefix-detail">$guidePrefix</a></td>
        <td></td>
        <td></td>
        <td><a href="yii-apidoc-renderers-baserenderer.html">yii\apidoc\renderers\BaseRenderer</a></td>
    </tr>
            <tr class="inherited" id="$guideUrl">
        <td><a href="yii-apidoc-renderers-baserenderer.html#$guideUrl-detail">$guideUrl</a></td>
        <td></td>
        <td></td>
        <td><a href="yii-apidoc-renderers-baserenderer.html">yii\apidoc\renderers\BaseRenderer</a></td>
    </tr>
            <tr id="$indexView">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#$indexView-detail">$indexView</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>Path or alias of the view file to use for rendering the index page.</td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr id="$layout">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#$layout-detail">$layout</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>Path or alias of the layout file to use.</td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr class="inherited" id="$pageTitle">
        <td><a href="yii-apidoc-renderers-baserenderer.html#$pageTitle-detail">$pageTitle</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>String to use as the title of the generated page.</td>
        <td><a href="yii-apidoc-renderers-baserenderer.html">yii\apidoc\renderers\BaseRenderer</a></td>
    </tr>
            <tr id="$typeView">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#$typeView-detail">$typeView</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>Path or alias of the view file to use for rendering types (classes, interfaces, traits).</td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr id="$view">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#$view-detail">$view</a></td>
        <td><a href="yii-web-view.html">yii\web\View</a></td>
        <td>The view instance</td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr id="$viewPath">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#$viewPath-detail">$viewPath</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The view path that may be prefixed to a relative view name.</td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
    </table>
</div>

<a id="methods"></a>

<div class="summary doc-method">
<h2>Public Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="__call()">
        <td><a href="yii-base-component.html#__call()-detail">__call()</a></td>
        <td>Calls the named method which is not a class method.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__clone()">
        <td><a href="yii-base-component.html#__clone()-detail">__clone()</a></td>
        <td>This method is called after the object is created by cloning an existing one.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__construct()">
        <td><a href="yii-base-object.html#__construct()-detail">__construct()</a></td>
        <td>Constructor.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__get()">
        <td><a href="yii-base-component.html#__get()-detail">__get()</a></td>
        <td>Returns the value of a component property.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__isset()">
        <td><a href="yii-base-component.html#__isset()-detail">__isset()</a></td>
        <td>Checks if a property is set, i.e. defined and not null.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__set()">
        <td><a href="yii-base-component.html#__set()-detail">__set()</a></td>
        <td>Sets the value of a component property.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__unset()">
        <td><a href="yii-base-component.html#__unset()-detail">__unset()</a></td>
        <td>Sets a component property to be null.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="attachBehavior()">
        <td><a href="yii-base-component.html#attachBehavior()-detail">attachBehavior()</a></td>
        <td>Attaches a behavior to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="attachBehaviors()">
        <td><a href="yii-base-component.html#attachBehaviors()-detail">attachBehaviors()</a></td>
        <td>Attaches a list of behaviors to the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="behaviors()">
        <td><a href="yii-base-component.html#behaviors()-detail">behaviors()</a></td>
        <td>Returns a list of behaviors that this component should behave as.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="canGetProperty()">
        <td><a href="yii-base-component.html#canGetProperty()-detail">canGetProperty()</a></td>
        <td>Returns a value indicating whether a property can be read.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="canSetProperty()">
        <td><a href="yii-base-component.html#canSetProperty()-detail">canSetProperty()</a></td>
        <td>Returns a value indicating whether a property can be set.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="className()">
        <td><a href="yii-base-object.html#className()-detail">className()</a></td>
        <td>Returns the fully qualified name of this class.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="createSubjectLink()">
        <td><a href="yii-apidoc-renderers-baserenderer.html#createSubjectLink()-detail">createSubjectLink()</a></td>
        <td>Creates a link to a subject</td>
        <td><a href="yii-apidoc-renderers-baserenderer.html">yii\apidoc\renderers\BaseRenderer</a></td>
    </tr>
            <tr class="inherited" id="createTypeLink()">
        <td><a href="yii-apidoc-renderers-baserenderer.html#createTypeLink()-detail">createTypeLink()</a></td>
        <td>Creates a link to a type (class, interface or trait)</td>
        <td><a href="yii-apidoc-renderers-baserenderer.html">yii\apidoc\renderers\BaseRenderer</a></td>
    </tr>
            <tr class="inherited" id="detachBehavior()">
        <td><a href="yii-base-component.html#detachBehavior()-detail">detachBehavior()</a></td>
        <td>Detaches a behavior from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="detachBehaviors()">
        <td><a href="yii-base-component.html#detachBehaviors()-detail">detachBehaviors()</a></td>
        <td>Detaches all behaviors from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="ensureBehaviors()">
        <td><a href="yii-base-component.html#ensureBehaviors()-detail">ensureBehaviors()</a></td>
        <td>Makes sure that the behaviors declared in <a href="yii-base-component.html#behaviors()-detail">behaviors()</a> are attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="generateApiUrl()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#generateApiUrl()-detail">generateApiUrl()</a></td>
        <td>Generate an url to a type in apidocs</td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
                <tr class="inherited" id="generateGuideUrl()">
        <td><a href="yii-apidoc-renderers-baserenderer.html#generateGuideUrl()-detail">generateGuideUrl()</a></td>
        <td>Generate an url to a guide page</td>
        <td><a href="yii-apidoc-renderers-baserenderer.html">yii\apidoc\renderers\BaseRenderer</a></td>
    </tr>
                <tr class="inherited" id="getBehavior()">
        <td><a href="yii-base-component.html#getBehavior()-detail">getBehavior()</a></td>
        <td>Returns the named behavior object.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="getBehaviors()">
        <td><a href="yii-base-component.html#getBehaviors()-detail">getBehaviors()</a></td>
        <td>Returns all behaviors attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="getSourceUrl()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#getSourceUrl()-detail">getSourceUrl()</a></td>
        <td></td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr id="getView()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#getView()-detail">getView()</a></td>
        <td></td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr id="getViewPath()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#getViewPath()-detail">getViewPath()</a></td>
        <td></td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr class="inherited" id="hasEventHandlers()">
        <td><a href="yii-base-component.html#hasEventHandlers()-detail">hasEventHandlers()</a></td>
        <td>Returns a value indicating whether there is any handler attached to the named event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="hasMethod()">
        <td><a href="yii-base-component.html#hasMethod()-detail">hasMethod()</a></td>
        <td>Returns a value indicating whether a method is defined.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="hasProperty()">
        <td><a href="yii-base-component.html#hasProperty()-detail">hasProperty()</a></td>
        <td>Returns a value indicating whether a property is defined for this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="init()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#init()-detail">init()</a></td>
        <td></td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr class="inherited" id="off()">
        <td><a href="yii-base-component.html#off()-detail">off()</a></td>
        <td>Detaches an existing event handler from this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="on()">
        <td><a href="yii-base-component.html#on()-detail">on()</a></td>
        <td>Attaches an event handler to an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="render()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#render()-detail">render()</a></td>
        <td>Renders a given <a href="yii-apidoc-models-context.html">yii\apidoc\models\Context</a>.</td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr id="renderClasses()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#renderClasses()-detail">renderClasses()</a></td>
        <td></td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr id="renderInheritance()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#renderInheritance()-detail">renderInheritance()</a></td>
        <td></td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr id="renderInterfaces()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#renderInterfaces()-detail">renderInterfaces()</a></td>
        <td></td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr id="renderMethodSignature()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#renderMethodSignature()-detail">renderMethodSignature()</a></td>
        <td></td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr id="renderPropertySignature()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#renderPropertySignature()-detail">renderPropertySignature()</a></td>
        <td></td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
            <tr id="renderTraits()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#renderTraits()-detail">renderTraits()</a></td>
        <td></td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
                <tr class="inherited" id="trigger()">
        <td><a href="yii-base-component.html#trigger()-detail">trigger()</a></td>
        <td>Triggers an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
    </table>
</div>

<div class="summary doc-method">
<h2>Protected Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
                                                                                    <tr id="generateFileName()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#generateFileName()-detail">generateFileName()</a></td>
        <td>Generates file name for API page for a given type</td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
                <tr id="generateLink()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#generateLink()-detail">generateLink()</a></td>
        <td>Generate link markup</td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
                                                                                    <tr id="renderWithLayout()">
        <td><a href="yii-apidoc-templates-html-apirenderer.html#renderWithLayout()-detail">renderWithLayout()</a></td>
        <td>Renders file applying layout</td>
        <td><a href="yii-apidoc-templates-html-apirenderer.html">yii\apidoc\templates\html\ApiRenderer</a></td>
    </tr>
        </table>
</div>

<a id="events"></a>

<a id="constants"></a>
<div class="summary doc-const">
    <h2>Constants</h2>

    <p><a href="#" class="toggle">Hide inherited constants</a></p>

    <table class="summary-table table table-striped table-bordered table-hover">
    <colgroup>
        <col class="col-const" />
        <col class="col-value" />
        <col class="col-description" />
        <col class="col-defined" />
    </colgroup>
    <tr>
        <th>Constant</th><th>Value</th><th>Description</th><th>Defined By</th>
    </tr>
            <tr class="inherited" id="GUIDE_PREFIX">
          <td id="GUIDE_PREFIX-detail">GUIDE_PREFIX</td>
          <td>'guide-'</td>
          <td>
</td>
          <td><a href="yii-apidoc-renderers-baserenderer.html">yii\apidoc\renderers\BaseRenderer</a></td>
        </tr>
        </table>
</div>

<h2>Property Details</h2>

<div class="property-doc">

    <div class="detail-header h3" id="$indexView-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#$indexView-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L45" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L45" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $indexView        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>Path or alias of the view file to use for rendering the index page.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-apidoc-templates-html-apirenderer.html#$indexView-detail">$indexView</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">'@yii/apidoc/templates/html/views/index.php'</span></div>


    <div class="detail-header h3" id="$layout-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#$layout-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L37" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L37" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $layout        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>Path or alias of the layout file to use.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-apidoc-templates-html-apirenderer.html#$layout-detail">$layout</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span></div>


    <div class="detail-header h3" id="$typeView-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#$typeView-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L41" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L41" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $typeView        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>Path or alias of the view file to use for rendering types (classes, interfaces, traits).</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-apidoc-templates-html-apirenderer.html#$typeView-detail">$typeView</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">'@yii/apidoc/templates/html/views/type.php'</span></div>


    <div class="detail-header h3" id="$view-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#$view-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $view        <span class="detail-header-tag small">
            public                         <em>read-only</em>                         property
                    </span>
    </div>

    <div class="doc-description">
        <p>The view instance</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-web-view.html">yii\web\View</a></span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#getView()-detail">getView</a></strong> ( )</div>


    <div class="detail-header h3" id="$viewPath-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#$viewPath-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $viewPath        <span class="detail-header-tag small">
            public                         <em>read-only</em>                         property
                    </span>
    </div>

    <div class="doc-description">
        <p>The view path that may be prefixed to a relative view name.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#getViewPath()-detail">getViewPath</a></strong> ( )</div>

</div>
<h2>Method Details</h2>

<div class="method-doc">

    <div class="detail-header h3" id="generateApiUrl()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#generateApiUrl()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L289" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L289" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        generateApiUrl()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Generate an url to a type in apidocs</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">mixed</span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#generateApiUrl()-detail">generateApiUrl</a></strong> ( <span style="color: #0000BB">$typeName</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$typeName</span></td>
                  <td class="param-type-col"></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="generateFileName()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#generateFileName()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L299" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L299" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        generateFileName()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Generates file name for API page for a given type</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#generateFileName()-detail">generateFileName</a></strong> ( <span style="color: #0000BB">$typeName</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$typeName</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="generateLink()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#generateLink()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L315" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L315" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        generateLink()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Generate link markup</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type">mixed</span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#generateLink()-detail">generateLink</a></strong> ( <span style="color: #0000BB">$text</span>, <span style="color: #0000BB">$href</span>, <span style="color: #0000BB">$options&nbsp;</span><span style="color: #007700">=&nbsp;[]</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$text</span></td>
                  <td class="param-type-col"></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$href</span></td>
                  <td class="param-type-col"></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$options</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Additional HTML attributes for the link.</p>
</td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="getSourceUrl()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#getSourceUrl()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L325" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L325" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        getSourceUrl()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#getSourceUrl()-detail">getSourceUrl</a></strong> ( <span style="color: #0000BB">$type</span>, <span style="color: #0000BB">$line&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$type</span></td>
                  <td class="param-type-col"></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$line</span></td>
                  <td class="param-type-col"></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="getView()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#getView()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L66" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L66" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        getView()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="yii-web-view.html">yii\web\View</a></span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#getView()-detail">getView</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="yii-web-view.html">yii\web\View</a></td>
                  <td class="param-desc-col"><p>The view instance</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="getViewPath()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#getViewPath()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L307" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L307" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        getViewPath()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#getViewPath()-detail">getViewPath</a></strong> ( )</td></tr>
                                                <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The view path that may be prefixed to a relative view name.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="init()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#init()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L54" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L54" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        init()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#init()-detail">init</a></strong> ( )</td></tr>
            </table>

<!--	-->

    <div class="detail-header h3" id="render()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#render()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L89" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L89" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        render()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Renders a given <a href="yii-apidoc-models-context.html">yii\apidoc\models\Context</a>.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#render()-detail">render</a></strong> ( <span style="color: #0000BB">$context</span>, <span style="color: #0000BB">$targetDir</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$context</span></td>
                  <td class="param-type-col"><a href="yii-apidoc-models-context.html">yii\apidoc\models\Context</a></td>
                  <td class="param-desc-col"><p>The api documentation context to render.</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$targetDir</span></td>
                  <td class="param-type-col"></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="renderClasses()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#renderClasses()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L208" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L208" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        renderClasses()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#renderClasses()-detail">renderClasses</a></strong> ( <span style="color: #0000BB">$names</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$names</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="renderInheritance()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#renderInheritance()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L149" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L149" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        renderInheritance()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#renderInheritance()-detail">renderInheritance</a></strong> ( <span style="color: #0000BB">$class</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$class</span></td>
                  <td class="param-type-col"><a href="yii-apidoc-models-classdoc.html">yii\apidoc\models\ClassDoc</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="renderInterfaces()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#renderInterfaces()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L170" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L170" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        renderInterfaces()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#renderInterfaces()-detail">renderInterfaces</a></strong> ( <span style="color: #0000BB">$names</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$names</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="renderMethodSignature()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#renderMethodSignature()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L257" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L257" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        renderMethodSignature()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#renderMethodSignature()-detail">renderMethodSignature</a></strong> ( <span style="color: #0000BB">$method</span>, <span style="color: #0000BB">$context&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$method</span></td>
                  <td class="param-type-col"><a href="yii-apidoc-models-methoddoc.html">yii\apidoc\models\MethodDoc</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$context</span></td>
                  <td class="param-type-col"></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="renderPropertySignature()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#renderPropertySignature()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L227" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L227" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        renderPropertySignature()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#renderPropertySignature()-detail">renderPropertySignature</a></strong> ( <span style="color: #0000BB">$property</span>, <span style="color: #0000BB">$context&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$property</span></td>
                  <td class="param-type-col"><a href="yii-apidoc-models-propertydoc.html">yii\apidoc\models\PropertyDoc</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$context</span></td>
                  <td class="param-type-col"></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="renderTraits()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#renderTraits()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L189" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L189" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        renderTraits()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong></strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#renderTraits()-detail">renderTraits</a></strong> ( <span style="color: #0000BB">$names</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$names</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="renderWithLayout()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-apidoc-templates-html-apirenderer.html#renderWithLayout()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-apidoc/edit/master/templates/html/ApiRenderer.php#L133" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/ApiRenderer.php#L133" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        renderWithLayout()
        <span class="detail-header-tag small">
            protected                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Renders file applying layout</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">protected</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-apidoc-templates-html-apirenderer.html#renderWithLayout()-detail">renderWithLayout</a></strong> ( <span style="color: #0000BB">$viewFile</span>, <span style="color: #0000BB">$params</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$viewFile</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The view name</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$params</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The parameters (name-value pairs) that will be extracted and made available in the view file.</p>
</td>
                </tr>
                                                </table>

<!--	-->
</div>
        </div>
</div>

<script type="text/javascript">
    /*<![CDATA[*/
    $("a.toggle").on('click', function () {
        var $this = $(this);
        if ($this.hasClass('properties-hidden')) {
            $this.text($this.text().replace(/Show/,'Hide'));
            $this.parents(".summary").find(".inherited").show();
            $this.removeClass('properties-hidden');
        } else {
            $this.text($this.text().replace(/Hide/,'Show'));
            $this.parents(".summary").find(".inherited").hide();
            $this.addClass('properties-hidden');
        }

        return false;
    });
    /*
     $(".sourceCode a.show").toggle(function () {
     $(this).text($(this).text().replace(/show/,'hide'));
     $(this).parents(".sourceCode").find("div.code").show();
     },function () {
     $(this).text($(this).text().replace(/hide/,'show'));
     $(this).parents(".sourceCode").find("div.code").hide();
     });
     $("a.sourceLink").click(function () {
     $(this).attr('target','_blank');
     });
     */
    /*]]>*/
</script>


</div>

<footer class="footer">
        <p class="pull-right"><small>Page generated on Sat, 09 Jul 2016 12:15:52 +0000</small></p>
    Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a></footer>

<script type="text/javascript">jQuery(document).ready(function () {
    var shiftWindow = function () { scrollBy(0, -50) };
    if (location.hash) setTimeout(shiftWindow, 1);
    window.addEventListener("hashchange", shiftWindow);
var element = document.createElement("script");
element.src = "./jssearch.index.js";
document.body.appendChild(element);

var searchBox = $('#searchbox');

// search when typing in search field
searchBox.on("keyup", function(event) {
    var query = $(this).val();

    if (query == '' || event.which == 27) {
        $('#search-resultbox').hide();
        return;
    } else if (event.which == 13) {
        var selectedLink = $('#search-resultbox a.selected');
        if (selectedLink.length != 0) {
            document.location = selectedLink.attr('href');
            return;
        }
    } else if (event.which == 38 || event.which == 40) {
        $('#search-resultbox').show();

        var selected = $('#search-resultbox a.selected');
        if (selected.length == 0) {
            $('#search-results').find('a').first().addClass('selected');
        } else {
            var next;
            if (event.which == 40) {
                next = selected.parent().next().find('a').first();
            } else {
                next = selected.parent().prev().find('a').first();
            }
            if (next.length != 0) {
                var resultbox = $('#search-results');
                var position = next.position();

//              TODO scrolling is buggy and jumps around
//                resultbox.scrollTop(Math.floor(position.top));
//                console.log(position.top);

                selected.removeClass('selected');
                next.addClass('selected');
            }
        }

        return;
    }
    $('#search-resultbox').show();
    $('#search-results').html('<li><span class="no-results">No results</span></li>');

    var result = jssearch.search(query);

    if (result.length > 0) {
        var i = 0;
        var resHtml = '';

        for (var key in result) {
            if (i++ > 20) {
                break;
            }
            resHtml = resHtml +
            '<li><a href="' + result[key].file.u.substr(3) +'"><span class="title">' + result[key].file.t + '</span>' +
            '<span class="description">' + result[key].file.d + '</span></a></li>';
        }
        $('#search-results').html(resHtml);
    }
});

// hide the search results on ESC
$(document).on("keyup", function(event) { if (event.which == 27) { $('#search-resultbox').hide(); } });
// hide search results on click to document
$(document).bind('click', function (e) { $('#search-resultbox').hide(); });
// except the following:
searchBox.bind('click', function(e) { e.stopPropagation(); });
$('#search-resultbox').bind('click', function(e) { e.stopPropagation(); });

});</script></body>
</html>
